Skip to content

Add VitePress documentation site with GitHub Pages deployment#585

Merged
farfromrefug merged 3 commits intomainfrom
copilot/add-website-documentation
Mar 13, 2026
Merged

Add VitePress documentation site with GitHub Pages deployment#585
farfromrefug merged 3 commits intomainfrom
copilot/add-website-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 10, 2026

Creates official documentation website for OSS Document Scanner and OSS Card Wallet, hosted at github.io/OSS-DocumentScanner/ with automated screenshot generation.

Implementation

Documentation Site (docs/)

  • VitePress static site with homepage, app overviews, feature docs, getting started guides
  • Asset sourcing: Icons, badges, and screenshots from fastlane/metadata/ and root directory copied to public/
  • Dynamic badges: External URLs for shields.io, weblate, app stores auto-update on source changes
  • Donation CTA: GitHub Sponsors link prominently featured on homepage

Automated Deployment

  • GitHub Actions workflow (.github/workflows/deploy-docs.yml) triggers on docs/** changes
  • Builds VitePress → deploys to GitHub Pages
  • Base path configured for /<repo-name>/ hosting

Screenshot Automation (.maestro/)

Six test flows for capturing app screenshots:

# Example: .maestro/screenshot_document_scanner_main.yaml
appId: com.akylas.documentscanner
---
- launchApp
- waitForAnimationToEnd
- takeScreenshot: screenshot_document_scanner_main

Covers main screens, camera views, and detail pages for both apps.

Website Preview

Documentation homepage

Post-Merge

Enable GitHub Pages in repository settings → Actions source. Site deploys automatically on next push to master.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • ofcncog2cu-dsn.algolia.net
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/_temp/ghcca-node/node/bin/yarn add -D vitepress vue --cwd . (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits March 10, 2026 10:01
…Maestro screenshot automation

Co-authored-by: farfromrefug <655344+farfromrefug@users.noreply.github.com>
Co-authored-by: farfromrefug <655344+farfromrefug@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants